gh-142349: Document LazyImportType.resolve() method - #156936
Conversation
Documentation build overview
19 files changed ·
|
This comment was marked as resolved.
This comment was marked as resolved.
johnslavik
left a comment
There was a problem hiding this comment.
Hmmm, https://docs.python.org/3.16/reference/simple_stmts.html#lazy doesn't know about types.LazyImportType. Additionally, none of the classes in types have method documentations.
Maybe the right place for this documentation is in https://docs.python.org/3.16/reference/simple_stmts.html#lazy?
|
And https://docs.python.org/3.16/library/types.html#types.LazyImportType doesn't know about https://docs.python.org/3.16/reference/simple_stmts.html#lazy. These guys should talk to each other. |
|
Actually, this belongs to built-in types. Generator (that isn't a builtin name) interface is documented there too. @Viicos can we move this to built-in types? |
|
I think documenting this in |
|
I indeed took I also know the stdlib page is huge and there are plans to split it, so not sure what should be done today. |
|
@encukou, what would you recommend? |
There was a problem hiding this comment.
IMO, eventually this should be in a new builtins section, but, that's not in place now :)
Any of the proposed locations fine; stick with the current version.
And https://docs.python.org/3.16/library/types.html#types.LazyImportType doesn't know about https://docs.python.org/3.16/reference/simple_stmts.html#lazy
The bigger issue is that reference/simple_stmts has a stub that refers to PEP 810 for the “full specification”, while PEP 810 points right back for the “canonical documentation”. The full spec should move to the docs. But that's not for this PR to solve.
I worked on this a while ago! |
Co-authored-by: Victorien <65306057+Viicos@users.noreply.github.com>
resolve()is referenced several times in PEP 810, but not documented. I believe it would make sense to explicitly document it.See also #156924.